Get product
curl --request GET \
--url https://firespark.cloud/api/storefront/v1/menus/products/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://firespark.cloud/api/storefront/v1/menus/products/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://firespark.cloud/api/storefront/v1/menus/products/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://firespark.cloud/api/storefront/v1/menus/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://firespark.cloud/api/storefront/v1/menus/products/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://firespark.cloud/api/storefront/v1/menus/products/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firespark.cloud/api/storefront/v1/menus/products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "burger-classic",
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"brand_id": "0001",
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Classic burger",
"description": "Angus beef patty with lettuce and tomato.",
"image_url": "https://cdn.example.com/burger-classic.jpg",
"channels": {
"APP": {
"id": "app",
"uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Mobile app",
"stores": {
"downtown": {
"id": "downtown",
"uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Downtown",
"fulfillment": {
"DELIVERY": {
"uid": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"id": "delivery",
"type": "DELIVERY",
"name": "Delivery",
"pricing": {
"minimum_quantity": 1,
"maximum_quantity": 10,
"is_tax_inclusive": true,
"tax_rate": 0.15,
"price": 12.99,
"anchor_price": 14.99,
"anchor_price_percentage": 0.13,
"modifiers": [],
"modifier_group_ids": ["choose-drink"]
},
"availability": {
"status": "AVAILABLE",
"schedules": [
{ "day_of_week": "monday", "periods": [{ "start_time": "11:00:00", "end_time": "22:00:00" }] }
],
"out_of_stock_until": null
},
"bundled_items": []
}
}
}
}
}
},
"cms_template_id": null,
"cms": null,
"status": "ACTIVE"
}
}
Menus
Get product
Load a product from a composed menu with pricing and availability.
GET
/
menus
/
products
/
{id}
Get product
curl --request GET \
--url https://firespark.cloud/api/storefront/v1/menus/products/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://firespark.cloud/api/storefront/v1/menus/products/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://firespark.cloud/api/storefront/v1/menus/products/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://firespark.cloud/api/storefront/v1/menus/products/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://firespark.cloud/api/storefront/v1/menus/products/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://firespark.cloud/api/storefront/v1/menus/products/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firespark.cloud/api/storefront/v1/menus/products/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "burger-classic",
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"brand_id": "0001",
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Classic burger",
"description": "Angus beef patty with lettuce and tomato.",
"image_url": "https://cdn.example.com/burger-classic.jpg",
"channels": {
"APP": {
"id": "app",
"uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Mobile app",
"stores": {
"downtown": {
"id": "downtown",
"uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Downtown",
"fulfillment": {
"DELIVERY": {
"uid": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"id": "delivery",
"type": "DELIVERY",
"name": "Delivery",
"pricing": {
"minimum_quantity": 1,
"maximum_quantity": 10,
"is_tax_inclusive": true,
"tax_rate": 0.15,
"price": 12.99,
"anchor_price": 14.99,
"anchor_price_percentage": 0.13,
"modifiers": [],
"modifier_group_ids": ["choose-drink"]
},
"availability": {
"status": "AVAILABLE",
"schedules": [
{ "day_of_week": "monday", "periods": [{ "start_time": "11:00:00", "end_time": "22:00:00" }] }
],
"out_of_stock_until": null
},
"bundled_items": []
}
}
}
}
}
},
"cms_template_id": null,
"cms": null,
"status": "ACTIVE"
}
}
Returns a single product from the active menu, including localized name and description, image, and per-channel pricing and availability. Use this endpoint for product detail pages or to hydrate cart line items.
Each fulfillment entry may also include
Each schedule entry contains
Requires a Fire spark access token obtained through token
exchange.
Path parameters
| Parameter | Description |
|---|---|
id | External product identifier. Alphanumeric characters, _, and - only. 1–64 characters. |
Query parameters
| Parameter | Required | Description |
|---|---|---|
fulfillment_id | No | External fulfillment identifier. |
store_id | No | External store identifier. |
channel_id | No | External channel identifier. |
brand_id | No | External brand identifier. |
Request
curl "https://firespark.cloud/api/storefront/v1/menus/products/burger-classic?fulfillment_id=delivery&store_id=downtown&channel_id=app&brand_id=0001" \
-H "Authorization: Bearer ACCESS_TOKEN"
Response
{
"data": {
"id": "burger-classic",
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"brand_id": "0001",
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Classic burger",
"description": "Angus beef patty with lettuce and tomato.",
"image_url": "https://cdn.example.com/burger-classic.jpg",
"channels": {
"APP": {
"id": "app",
"uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Mobile app",
"stores": {
"downtown": {
"id": "downtown",
"uid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Downtown",
"fulfillment": {
"DELIVERY": {
"uid": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"id": "delivery",
"type": "DELIVERY",
"name": "Delivery",
"pricing": {
"minimum_quantity": 1,
"maximum_quantity": 10,
"is_tax_inclusive": true,
"tax_rate": 0.15,
"price": 12.99,
"anchor_price": 14.99,
"anchor_price_percentage": 0.13,
"modifiers": [],
"modifier_group_ids": ["choose-drink"]
},
"availability": {
"status": "AVAILABLE",
"schedules": [
{ "day_of_week": "monday", "periods": [{ "start_time": "11:00:00", "end_time": "22:00:00" }] }
],
"out_of_stock_until": null
},
"bundled_items": []
}
}
}
}
}
},
"cms_template_id": null,
"cms": null,
"status": "ACTIVE"
}
}
Product object
| Field | Type | Description |
|---|---|---|
id | string | External product identifier. |
uid | string (UUID) | Fire spark internal identifier. |
brand_id | string | null | External brand identifier. null when the resource is not brand-scoped. |
organization_id | string (UUID) | Fire spark organization identifier. |
merchant_id | string (UUID) | Fire spark merchant identifier. |
name | string | Display name. 1–100 characters. |
description | string | Optional description. Up to 500 characters. null when omitted. |
image_url | string | Product image URL. |
channels | object | Per-channel, per-store, per-fulfillment pricing and availability. |
cms_template_id | string (UUID) | CMS template linked to this product. null when no template is assigned. |
cms | object | Read-only. Resolved CMS template when assigned. |
status | string | ACTIVE or INACTIVE. |
channels
channels
Map of channel codes. Each entry contains
id, uid, name, and a stores map.Each store contains id, uid, name, and a fulfillment map keyed by fulfillment type code.Each fulfillment entry requires uid, id, type, name, pricing, and availability.pricing
pricing
| Field | Required | Type | Description |
|---|---|---|---|
minimum_quantity | Yes | number | Minimum units per order. ≥ 0. |
maximum_quantity | Yes | number | Maximum units per order. 0–1,000,000. |
is_tax_inclusive | Yes | boolean | Whether price includes tax. |
tax_rate | Yes | number | Tax rate as a decimal (for example 0.15 for 15%). 0–1. |
price | Yes | number | List price. ≥ 0. |
anchor_price | Yes | number | Reference price for strikethrough or comparison. ≥ 0. |
anchor_price_percentage | Yes | number | Discount shown relative to anchor_price. 0–1. |
modifiers | No | array | Per-modifier pricing overrides. Defaults to []. |
modifier_group_ids | No | array | Modifier groups attached to this product. Defaults to []. |
bundled_items — items included in a bundle or combo:| Field | Required | Type | Description |
|---|---|---|---|
id | Yes | string | External identifier of the bundled product. |
refund_price | Yes | number | Refund amount when the customer removes this item. ≥ 0. |
included_quantity | Yes | number | Units included by default. ≥ 0. |
availability
availability
| Field | Required | Type | Description |
|---|---|---|---|
status | Yes | string | AVAILABLE, UNAVAILABLE, or OUT_OF_STOCK. |
schedules | No | array | null | Schedule entries with day_of_week and periods. null when there is no schedule restriction. |
out_of_stock_until | No | string | Optional ISO 8601 datetime when the product returns to stock. |
day_of_week (monday through sunday) and a periods array. Each period has optional closed (default false), start_time, end_time, and optional start_date / end_date bounds.Error responses
| Status | Description |
|---|---|
401 | Missing or invalid access token. |
403 | Token does not have access to this product. |
404 | Product not found in the active menu for this context. |
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
External product identifier.
Required string length:
1 - 64Pattern:
^[a-zA-Z0-9_-]+$Query Parameters
External fulfillment identifier.
Required string length:
1 - 64Pattern:
^[a-zA-Z0-9_-]+$External store identifier.
Required string length:
1 - 64Pattern:
^[a-zA-Z0-9_-]+$External channel identifier.
Required string length:
1 - 64Pattern:
^[a-zA-Z0-9_-]+$External brand identifier.
Required string length:
1 - 64Pattern:
^[a-zA-Z0-9_-]+$Response
200 - application/json
Ok
Show child attributes
Show child attributes
⌘I